home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Tools / vtcl / doc / CrtMathFnc.3 < prev    next >
Encoding:
Text File  |  1995-07-10  |  4.7 KB  |  122 lines
  1. '\"
  2. '\" Copyright (c) 1989-1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/CrtMathFnc.3,v 1.1 93/04/14 16:35:59 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. '\"----------------------------------------------------------------------------
  24. '\"    @(#) CrtMathFnc.3 26.1 93/10/22 SCOINC
  25. '\"
  26. '\"     Copyright (C) The Santa Cruz Operation, 1992-1993.
  27. '\"     This Module contains Proprietary Information of
  28. '\"    The Santa Cruz Operation, and should be treated as Confidential.
  29. '\"----------------------------------------------------------------------------
  30. .so ../man.macros
  31. .HS Tcl_CreateMathFunc tclc 7.0
  32. .BS
  33. .SH NAME
  34. Tcl_CreateMathFunc \- Define a new math function for expressions
  35. .SH SYNOPSIS
  36. .nf
  37. \fB#include <tcl.h>\fR
  38. .sp
  39. \fBTcl_CreateMathFunc\fR(\fIinterp, name, numArgs, argTypes, proc, clientData\fR)
  40. .SH ARGUMENTS
  41. .AS Tcl_ValueType clientData
  42. .AP Tcl_Interp *interp in
  43. Interpreter in which new function will be defined.
  44. .AP char *name in
  45. Name for new function.
  46. .AP int numArgs in
  47. Number of arguments to new function;  also gives size of \fIargTypes\fR array.
  48. .AP Tcl_ValueType *argTypes in
  49. Points to an array giving the permissible types for each argument to
  50. function.
  51. .AP Tcl_MathProc *proc in
  52. Procedure that implements the function.
  53. .AP ClientData clientData in
  54. Arbitrary one-word value to pass to \fIproc\fR when it is invoked.
  55. .BE
  56.  
  57. .SH DESCRIPTION
  58. .PP
  59. Tcl allows a number of mathematical functions to be used in
  60. expressions, such as \fBsin\fR, \fBcos\fR, and \fBhypot\fR.
  61. \fBTcl_CreateMathFunc\fR allows applications to add additional functions
  62. to those already provided by Tcl or to replace existing functions.
  63. \fIName\fR is the name of the function as it will appear in expressions.
  64. If \fIname\fR doesn't already exist as a function then a new function
  65. is created.  If it does exist, then the existing function is replaced.
  66. \fINumArgs\fR and \fIargTypes\fR describe the arguments to the function.
  67. Each entry in the \fIargTypes\fR array must be either TCL_INT, TCL_DOUBLE,
  68. or TCL_EITHER to indicate whether the corresponding argument must be an
  69. integer, a double-precision floating value, or either, respectively.
  70. .PP
  71. Whenever the function is invoked in an expression Tcl will invoke
  72. \fIproc\fR.  \fIProc\fR should have arguments and result that match
  73. the type \fBTcl_MathProc\fR:
  74. .nf
  75. .RS
  76. typedef int Tcl_MathProc(
  77. .RS
  78. ClientData \fIclientData\fR,
  79. Tcl_Interp *\fIinterp\fR,
  80. Tcl_Value *\fIargs\fR,
  81. Tcl_Value *resultPtr\fR);
  82. .RE
  83. .RE
  84. .fi
  85. .PP
  86. When \fIproc\fR is invoked the \fIclientData\fR and \fIinterp\fR
  87. arguments will be the same as those passed to \fBTcl_CreateMathFunc\fR.
  88. \fIArgs\fR will point to an array of \fInumArgs\fR Tcl_Value structures,
  89. which describe the actual arguments to the function:
  90. .nf
  91. .RS
  92. typedef struct Tcl_Value {
  93. .RS
  94. Tcl_ValueType \fItype\fR;
  95. int \fIintValue\fR;
  96. double \fIdoubleValue\fR;
  97. .RE
  98. } Tcl_Value;
  99. .RE
  100. .fi
  101. .PP
  102. The \fItype\fR field indicates the type of the argument and is
  103. either TCL_INT or TCL_DOUBLE.
  104. It will match the \fIargTypes\fR value specified for the function unless
  105. the \fIargTypes\fR value was TCL_EITHER. Tcl converts
  106. the argument supplied in the expression to the type requested in
  107. \fIargTypes\fR, if that is necessary.
  108. Depending on the value of the \fItype\fR field, the \fIintValue\fR
  109. or \fIdoubleValue\fR field will contain the actual value of the argument.
  110. .PP
  111. \fIProc\fR should compute its result and store it either as an integer
  112. in \fIresultPtr->intValue\fR or as a floating value in
  113. \fIresultPtr->doubleValue\fR.
  114. It should set also \fIresultPtr->type\fR to either TCL_INT or TCL_DOUBLE
  115. to indicate which value was set.
  116. Under normal circumstances \fIproc\fR should return TCL_OK.
  117. If an error occurs while executing the function, \fIproc\fR should
  118. return TCL_ERROR and leave an error message in \fIinterp->result\fR.
  119.  
  120. .SH KEYWORDS
  121. expression, mathematical function
  122.